| API Documentation |  |

- MAIN PAGE
- NAMESPACES
- CLASSES

ComplexEffect.h
1 // ComplexEffect.h
3 //
5
6 namespace nkAstraeus
7 {
17 class ComplexEffect
18 {
19 public :
20
27 ComplexEffect (COMPLEX_EFFECT_TYPE type) noexcept ;
31 virtual ~ComplexEffect () ;
32
33 // Getters
37 nkMemory::StringView getName () const ;
41 nkGraphics::CompositorNode* getCompositorNode () const ;
45 COMPLEX_EFFECT_TYPE getType () const ;
46
47 // Setters
56 void setName (nkMemory::StringView value) ;
65 void setCompositorNode (nkGraphics::CompositorNode* value) ;
66
67 // Load
74 virtual bool load () = 0 ;
79 virtual void unload () = 0 ;
80 } ;
81 }
nkAstraeus::ComplexEffect::getType
COMPLEX_EFFECT_TYPE getType() const
nkAstraeus::COMPLEX_EFFECT_TYPE
COMPLEX_EFFECT_TYPE
Enumerates all complex effects available in the component.
Definition: ComplexEffectType.h:12
nkAstraeus::ComplexEffect::setCompositorNode
void setCompositorNode(nkGraphics::CompositorNode *value)
nkGraphics::CompositorNode
A node in the rendering graph described by a Compositor.
Definition: CompositorNode.h:12
nkAstraeus::ComplexEffect::ComplexEffect
ComplexEffect(COMPLEX_EFFECT_TYPE type) noexcept
nkAstraeus::ComplexEffect
Base class for all complex effects in the component.
Definition: ComplexEffect.h:18
nkAstraeus::ComplexEffect::getName
nkMemory::StringView getName() const
nkAstraeus
Encompasses all API of component NilkinsAstraeus.
Definition: BlurComplexEffect.h:7
nkMemory::StringView
Class holding information about a string, with no ownership over the data.
Definition: StringView.h:22
nkAstraeus::ComplexEffect::unload
virtual void unload()=0
nkAstraeus::ComplexEffect::~ComplexEffect
virtual ~ComplexEffect()
nkAstraeus::ComplexEffect::setName
void setName(nkMemory::StringView value)
nkAstraeus::ComplexEffect::load
virtual bool load()=0
nkAstraeus::ComplexEffect::getCompositorNode
nkGraphics::CompositorNode * getCompositorNode() const